From 624493c7690bab1792bb115bfd1b49cbbcc27721 Mon Sep 17 00:00:00 2001
From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Fri, 17 Mar 2017 18:00:29 +0300
Subject: [PATCH] Encourage tools writers to explicitly pin metadata version

---
 src/bin/metadata.rs | 11 ++++++++---
 tests/metadata.rs   | 19 +++++++++++++++++--
 2 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/src/bin/metadata.rs b/src/bin/metadata.rs
index b96e641e2..00d46c005 100644
--- a/src/bin/metadata.rs
+++ b/src/bin/metadata.rs
@@ -9,7 +9,7 @@ pub struct Options {
     flag_color: Option<String>,
     flag_features: Vec<String>,
     flag_all_features: bool,
-    flag_format_version: u32,
+    flag_format_version: Option<u32>,
     flag_manifest_path: Option<String>,
     flag_no_default_features: bool,
     flag_no_deps: bool,
@@ -34,7 +34,7 @@ Options:
     --no-deps                  Output information only about the root package
                                and don't fetch dependencies.
     --manifest-path PATH       Path to the manifest
-    --format-version VERSION   Format version [default: 1]
+    --format-version VERSION   Format version
                                Valid values: 1
     -v, --verbose ...          Use verbose output (-vv very verbose/build.rs output)
     -q, --quiet                No output printed to stdout
@@ -51,12 +51,17 @@ pub fn execute(options: Options, config: &Config) -> CliResult {
                      options.flag_locked)?;
     let manifest = find_root_manifest_for_wd(options.flag_manifest_path, config.cwd())?;
 
+    if options.flag_format_version.is_none() {
+        config.shell().warn("please specify `--format-version` flag explicitly to \
+                             avoid compatibility problems")?
+    }
+
     let options = OutputMetadataOptions {
         features: options.flag_features,
         all_features: options.flag_all_features,
         no_default_features: options.flag_no_default_features,
         no_deps: options.flag_no_deps,
-        version: options.flag_format_version,
+        version: options.flag_format_version.unwrap_or(1),
     };
 
     let ws = Workspace::new(&manifest, config)?;
diff --git a/tests/metadata.rs b/tests/metadata.rs
index ad775f1f9..313326391 100644
--- a/tests/metadata.rs
+++ b/tests/metadata.rs
@@ -53,6 +53,21 @@ fn cargo_metadata_simple() {
     }"#));
 }
 
+#[test]
+fn cargo_metadata_warns_on_implicit_version() {
+    let p = project("foo")
+        .file("src/foo.rs", "")
+        .file("Cargo.toml", &basic_bin_manifest("foo"));
+    p.build();
+
+    assert_that(p.cargo("metadata"),
+                execs().with_stderr("\
+[WARNING] please specify `--format-version` flag explicitly to avoid compatibility problems"));
+
+    assert_that(p.cargo("metadata").arg("--format-version").arg("1"),
+                execs().with_stderr(""));
+}
+
 #[test]
 fn library_with_several_crate_types() {
     let p = project("foo")
@@ -520,8 +535,8 @@ fn cargo_metadata_with_invalid_manifest() {
     let p = project("foo")
             .file("Cargo.toml", "");
 
-    assert_that(p.cargo_process("metadata"), execs().with_status(101)
-                                                    .with_stderr("\
+    assert_that(p.cargo_process("metadata").arg("--format-version").arg("1"),
+                execs().with_status(101).with_stderr("\
 [ERROR] failed to parse manifest at `[..]`
 
 Caused by:
-- 
2.30.2